Add doc content for new Ingress annotation http01-ingress-ingressclassname
#1848
Conversation
cert-manager-prow
bot
added
dco-signoff: yes
✅ Deploy Preview for cert-manager ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
lunarwhite
force-pushed
the
new-anno
branch
2 times, most recently
from
bba2172 to
8d35518
Compare
|
/cc @maelvls Please feel free to review it once you get the bandwidth. Thank you |
cert-manager-prow
bot
added
size/L
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
…ride-ingress-ingressclassname" Signed-off-by: Yuedong Wu <[email protected]>
…ingressclassname" Signed-off-by: Yuedong Wu <[email protected]>
cert-manager-prow
bot
added
size/M
SgtCoDFish
left a comment
SgtCoDFish
left a comment
There was a problem hiding this comment.
2 minor things with some suggestions. Thank you 🙏
| - `acme.cert-manager.io/http01-ingress-class`: this annotation allows you to | ||
| configure the ingress class that will be used to solve challenges for this | ||
| ingress. Customizing this is useful when you are trying to secure internal | ||
| configure the `kubernetes.io/ingress.class` that will be used to solve challenges | ||
| for this ingress. Customizing this is useful when you are trying to secure internal | ||
| services, and need to solve challenges using a different ingress class to that | ||
| of the ingress. If not specified and the `acme-http01-edit-in-place` annotation | ||
| is not set, this defaults to the ingress class defined in the Issuer resource. | ||
| is not set, this defaults to the `http01.ingress.class` defined in the Issuer resource. | ||
|
|
||
| - `acme.cert-manager.io/http01-ingress-ingressclassname`: this annotation allows you to | ||
| configure the `spec.ingressClassName` that will be used to solve challenges | ||
| for this ingress. Customizing this is useful when you are trying to secure internal | ||
| services, and need to solve challenges using a different ingress class to that | ||
| of the ingress. If not specified and the `acme-http01-edit-in-place` annotation | ||
| is not set, this defaults to the `http01.ingress.ingressClassName` defined in the | ||
| Issuer resource. |
There was a problem hiding this comment.
comment: I'd prefer if this wasn't written "this annotation..." but I totally recognise that's how it already is, and we definitely shouldn't rework this page in this PR. This is really good, thank you 👍
Co-authored-by: Ashley Davis <[email protected]> Signed-off-by: Yuedong Wu <[email protected]>
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for the new acme.cert-manager.io/http01-ingress-ingressclassname annotation, which allows users to configure the spec.ingressClassName field for HTTP01 challenge solving. This complements the existing http01-ingress-class annotation that configures the legacy kubernetes.io/ingress.class annotation.
- Adds documentation for the new
http01-ingress-ingressclassnameannotation across multiple documentation pages - Adds a redirect for the new annotation to ensure proper URL routing
- Updates the spelling dictionary to include the new annotation name
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| public/_redirects | Adds redirect rule for the new annotation documentation URL |
| content/docs/usage/ingress.md | Documents the new annotation in the Ingress usage guide with configuration details |
| content/docs/reference/annotations.md | Adds reference documentation for the new annotation and clarifies the existing http01-ingress-class annotation |
| content/docs/configuration/acme/http01/README.md | Adds notes about overriding both ingressClassName and class on a per-Ingress basis |
| .spelling | Adds the new annotation name to the spelling dictionary |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
2 participants
Preview:
https://deploy-preview-1848--cert-manager.netlify.app/docs/reference/annotations/#acmecert-manageriohttp01-ingress-ingressclassname
https://deploy-preview-1848--cert-manager.netlify.app/docs/reference/annotations/#acmecert-manageriohttp01-ingress-class
https://deploy-preview-1848--cert-manager.netlify.app/docs/usage/ingress/#supported-annotations
https://deploy-preview-1848--cert-manager.netlify.app/docs/configuration/acme/http01/#options
Background:
cert-manager/cert-manager#8244
cert-manager/cert-manager#6184